IRIX Base Documentation 2002 November/SGI IRIX Base Documentation 2002 November.iso/usr/share/catman/p_man/cat3/il/ilViewCallback.z/ilViewCallback

Text File | 2002-10-03 | 16.7 KB | 397 lines

iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))



NNNNAAAAMMMMEEEE
     iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk,,,, iiiillllVVVViiiieeeewwwwCCCCbbbbAAAArrrrgggg - argument passed to ilView callbacks

IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
     ilLinkItem

HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
     #include <il/ilViewCallback.h>

CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
     This class encapsulates the information passed to an iiiillllVVVViiiieeeewwww callback.  It
     represents the state of the ilView when its callback function is called
     and provides the ability to query various view attributes. Note that an
     ilViewCbArg is passed to callback functions and cannot be directly
     created.

     An ilView callback may be derived from iiiillllVVVViiiieeeewwwwMMMMeeeetttthhhhooooddddCCCCaaaallllllllbbbbaaaacccckkkk or
     iiiillllVVVViiiieeeewwwwFFFFuuuunnnnccccttttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk, similar to ilCallback. In both cases, an
     iiiillllVVVViiiieeeewwwwCCCCbbbbAAAArrrrgggg is passed to the callback function to provide access to
     ilView state information.

CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
     CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss

          ilViewMethodCallback(UserClass* object,
                         ilStatus (UserClass::*method)(UserArgType userArg,
                                              ilViewCbArg* callerArg),
                         UserArgType userArg)

          ilViewFunctionCallback(ilStatus (*func)(UserArgType userArg,
                                      ilViewCbArg* callerArg),
                           UserArgType userArg)

     DDDDiiiissssppppllllaaaayyyy qqqquuuueeeerrrryyyy mmmmeeeetttthhhhooooddddssss

          ilDisplay* getDisplay()
          Display* getILXDisplay()
          Display* getXDisplay()

     VVVViiiieeeewwww qqqquuuueeeerrrryyyy mmmmeeeetttthhhhooooddddssss

          void copyBorderList(ilIndexableList& bList)  _p_r_o_t_e_c_t_e_d
          void getBorders(iflTile2Dint& top, iflTile2Dint& bot,
                          iflTile2Dint& lf, iflTile2Dint& rt,
                          iflOrientation orientation)
          void getDel(iflXYint& dVPos, iflXYint& dVSize, iflXYZfloat& dIPos,
                      iflOrientation workOrientation=iflOrientation(0))
          void getImgPos(float& x, float& y)
          void getNewViewTile(iflTile2D<int>& tile)
          void getOldViewTile(iflTile2D<int>& tile)
          int getState()
          ilView* getView()



                                                                        PPPPaaaaggggeeee 1111






iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))



          void getViewPos(int& x, int& y)
          void getViewSize(int& nx, int& ny)
          int viewExposed()
          int viewMoved()
          int viewResized()
          int imgMoved()
          int viewBorders()

     VVVViiiieeeewwww ccccoooooooorrrrddddiiiinnnnaaaatttteeee mmmmaaaappppppppiiiinnnngggg

          iflOrientation getEventOrientation()
          iflOrientation getWorkOrientation()
          void mapTile(iflTile2Dint& tile, iflOrientation workOrientation=iflOrientation(0))
          void mapTile(iflTile2Dfloat& tile, iflOrientation workOrientation=iflOrientation(0))
          void mapXY(int& x, int& y, iflOrientation workOrientation=iflOrientation(0))
          void mapXY(float& x, float& y, iflOrientation workOrientation=iflOrientation(0))


FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
     iiiillllVVVViiiieeeewwwwFFFFuuuunnnnccccttttiiiioooonnnnCCCCaaaallllllllbbbbaaaacccckkkk(((())))

          ilViewFunctionCallback(ilStatus (*func)(UserArgType userArg,
                                      ilViewCbArg* callerArg),
                           UserArgType userArg)



          This constructor creates a callback to function, _f_u_n_c, with user
          argument, _u_s_e_r_A_r_g and caller argument _c_a_l_l_e_r_A_r_g.  The caller
          argument is a pointer to iiiillllVVVViiiieeeewwwwCCCCbbbbAAAArrrrgggg which is described within this
          man page.  iiiillllVVVViiiieeeewwwwMMMMeeeetttthhhhooooddddCCCCaaaallllllllbbbbaaaacccckkkk(((())))

          ilViewMethodCallback(UserClass* object,
                         ilStatus (UserClass::*method)(UserArgType userArg,
                                              ilViewCbArg* callerArg),
                         UserArgType userArg)



          This constructor creates a callback to _U_s_e_r_C_l_a_s_s::_m_e_t_h_o_d, with user
          argument, _u_s_e_r_A_r_g and caller argument _c_a_l_l_e_r_A_r_g.  The caller
          argument is a pointer to iiiillllVVVViiiieeeewwwwCCCCbbbbAAAArrrrgggg which is described within this
          man page.

     ccccooooppppyyyyBBBBoooorrrrddddeeeerrrrLLLLiiiisssstttt(((())))                        _p_r_o_t_e_c_t_e_d

          void copyBorderList(ilIndexableList& bList)


          Copies list of border tiles from _b_L_i_s_t into ilViewCbArg's
          borderList.  This is typically called by ilView in preparation for
          invoking a callback.



                                                                        PPPPaaaaggggeeee 2222






iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))



     ggggeeeettttBBBBoooorrrrddddeeeerrrrssss(((())))

          void getBorders(iflTile2Dint& top, iflTile2Dint& bot,
                          iflTile2Dint& lf, iflTile2Dint& rt,
                          iflOrientation orientation)


          Returns the top, bottom, left and right tiles that describe the
          unclipped border around an ilView in ttttoooopppp, bbbbooootttt, llllffff and rrrrtttt. The tiles
          are mapped to the iiiiffffllllOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn passed in _o_r_i_e_n_t_a_t_i_o_n.  Note that
          if a view is partially obscured by another, the border may be broken
          into several sections. See ggggeeeettttBBBBoooorrrrddddeeeerrrrLLLLiiiisssstttt().

     ggggeeeettttDDDDeeeellll(((())))

          void getDel(iflXYint& dVPos, iflXYint& dVSize, iflXYZfloat& dIPos,
                      iflOrientation workOrientation=iflOrientation(0))


          Returns the delta, or change, for the view's position, size and
          image position in _d_V_P_o_s, _d_V_S_i_z_e and _d_I_P_o_s respectively. The deltas
          are returned relative to the specified orientation. By default, the
          deltas are returned relative to the view's work orientation which is
          upper-left.  See iiiillllVVVViiiieeeewwww.

     ggggeeeettttDDDDiiiissssppppllllaaaayyyy(((())))

          ilDisplay* getDisplay()


          Returns a pointer to the iiiillllDDDDiiiissssppppllllaaaayyyy that manages the view.

     ggggeeeettttEEEEvvvveeeennnnttttOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))

          iflOrientation getEventOrientation()


          Returns the orientation used to interpret events.

     ggggeeeettttIIIILLLLXXXXDDDDiiiissssppppllllaaaayyyy(((())))

          Display* getILXDisplay()


          Returns a pointer to the internal X display used by IL for rendering
          to the display window. It is used by the the render callback which
          is called by the IL rendering thread. See ilView.

     ggggeeeettttIIIImmmmggggPPPPoooossss(((())))






                                                                        PPPPaaaaggggeeee 3333






iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))



          void getImgPos(float& x, float& y)


          Returns the image position in _x and _y. The image position is the
          location of the view corner nearest the image origin. In other
          words, it is the tile representing the portion of the image
          displayed in the view.  See iiiillllVVVViiiieeeewwww.

     ggggeeeettttNNNNeeeewwwwVVVViiiieeeewwwwTTTTiiiilllleeee(((())))

          void getNewViewTile(iflTile2D<int>&tile)


          Returns the tile that defines the new view location within the
          display.

     ggggeeeettttOOOOllllddddVVVViiiieeeewwwwTTTTiiiilllleeee(((())))

          void getOldViewTile(iflTile2D<int>&tile)


          Returns the tile that defines the old view location within the
          display.

     ggggeeeettttSSSSttttaaaatttteeee(((())))

          int getState()


          Returns the state of the view when the callback is called.  See
          iiiillllVVVViiiieeeewwww.

     ggggeeeettttVVVViiiieeeewwww(((())))

          ilView* getView()


          Returns a pointer to the iiiillllVVVViiiieeeewwww associated with the callback.

     ggggeeeettttVVVViiiieeeewwwwPPPPoooossss(((())))

          void getViewPos(int& x, int& y)


          Returns the view position in _x and _y relative the work orientation
          which is upper-left. See iiiillllVVVViiiieeeewwww.

     ggggeeeettttVVVViiiieeeewwwwSSSSiiiizzzzeeee(((())))

          void getViewSize(int& nx, int& ny)





                                                                        PPPPaaaaggggeeee 4444






iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))



          Returns the view size in _n_x and _n_y when the callback was called.
          See iiiillllVVVViiiieeeewwww.

     ggggeeeettttWWWWoooorrrrkkkkOOOOrrrriiiieeeennnnttttaaaattttiiiioooonnnn(((())))

          iflOrientation getWorkOrientation()


          Returns the work orientation for the ilView. The work orientation is
          used for internal computation and is the default orientation for may
          member functions.

     ggggeeeettttXXXXDDDDiiiissssppppllllaaaayyyy(((())))

          Display* getXDisplay()


          Returns a pointer to the X display associated with the display
          window.

     iiiimmmmggggMMMMoooovvvveeeedddd(((())))

          int imgMoved()


          Returns _T_r_u_e if the image within the ilView has been moved.
          Otherwise it returns _F_a_l_s_e.

     mmmmaaaappppTTTTiiiilllleeee(((())))

          void mapTile(iflTile2Dfloat& tile,
                       iflOrientation workOrientation=iflOrientation(0))
          void mapTile(iflTile2Dint& tile,
                       iflOrientation workOrientation=iflOrientation(0))


          This overloaded member function is a convience and maps the
          specified _t_i_l_e to the specified orientation. By default the tile is
          mapped to the work orientation which is upper-left.

     mmmmaaaappppXXXXYYYY(((())))

          void mapXY(float& x, float& y,
                     iflOrientation workOrientation=iflOrientation(0))
          void mapXY(int& x, int& y,
                     iflOrientation workOrientation=iflOrientation(0))


          This overloaded member function is a convience and maps the
          specified _x and _y_t_o coordinate to the specified orientation. By
          default the tile is mapped to the work orientation which is upper-
          left.



                                                                        PPPPaaaaggggeeee 5555






iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))  IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll  iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk((((3333))))



     vvvviiiieeeewwwwBBBBoooorrrrddddeeeerrrrssss(((())))

          int viewBorders()


          Returns _T_r_u_e if the view has borders enabled. Otherwise it returns
          _F_a_l_s_e.

     vvvviiiieeeewwwwEEEExxxxppppoooosssseeeedddd(((())))

          int viewExposed()


          Returns _T_r_u_e if the ilView has been exposed. Otherwise it returns
          _F_a_l_s_e.

     vvvviiiieeeewwwwMMMMoooovvvveeeedddd(((())))

          int viewMoved()


          Returns _T_r_u_e if the ilView has been moved. Otherwise it returns
          _F_a_l_s_e.

     vvvviiiieeeewwwwRRRReeeessssiiiizzzzeeeedddd(((())))

          int viewResized()


          Returns _T_r_u_e if the ilView has been resized. Otherwise it returns
          _F_a_l_s_e.

SSSSEEEEEEEE AAAALLLLSSSSOOOO
     ilCallback, ilView





















                                                                        PPPPaaaaggggeeee 6666